/*
 * @(#) $Header$
 *
 * Copyright (C) 2006  Daniel Léonard
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package ca.forklabs.baselib.util.iterator;

import ca.forklabs.baselib.util.iterator.ArrayIterator;

/**
 * Class {@code SingleObjectIterator} is a <em>forward</em>
 * <em>non-alterable</em> and <em>non-appendable</em> iterator over a single
 * object, as if it were a collection consisting of a single element.
 *
 * @param   <E>   the type of the object.
 *
 * @author <a href="mailto:forklabs at gmail.com?subject=ca.forklabs.baselib.util.iterator.SingleObjectIterator">Daniel Léonard</a>
 * @version $Revision$
 */
public class SingleObjectIterator<E> extends ArrayIterator<E> {

//---------------------------
// Constructor
//---------------------------

   /**
    * Constructor.
    * @param   single_object   the single object to iterate over.
    */
   @SuppressWarnings("unchecked")
   public SingleObjectIterator(E single_object) {
      super(single_object);
      }


//---------------------------
// Overridden methods from ca.forklabs.baselib.util.iterator.ArrayIterator
//---------------------------

   /**
    * Unsupported operation.
    * @param   element   ignored.
    * @exception   UnsupportedOperationException   always.
    */
   @Override
   @SuppressWarnings("nls")
   public void set(E element) {
      String message = this.getUnsupportedMethodErrorMessage("set(E)");
      throw new UnsupportedOperationException(message);
      }

   }
